Skip to main content

Transfer Order API - Package

Version 1.0 — April 2025

Authentication: All requests require an IdToken from the Login API. See Authentication to obtain one and Errors for authorization errors.

Create Package Transfer Order API​

Create Package Transfer Order API allows you to create a transfer order and track the packages associated with it.

Endpoint Details​

  • URL: https://api.xemelgo.com/graphql
  • Method: POST

Properties​

PropertyTypeDescriptionRequired
idStringTransfer order IDYes
trackerSerialStringTracker serial numberNo
transferFromIdStringSource location IDNo
transferToIdStringDestination location IDNo
packagesArrayList of packages (defined below)No
customPropertiesAWSJSONAdditional properties applicable to transfer ordersNo

packages​

Each object in the packages array includes the following properties:

PropertyTypeDescriptionRequired
idStringUnique package IDYes
trackerSerialStringTracker serial number assigned to the packageNo
reuseTrackerSerialBooleanIndicates if the tracker serial can be reusedNo
nameStringName of the packageNo
descriptionStringDescription of the packageNo
commentsStringAdditional comments about the packageNo
locationIdStringLocation ID where the package is currently storedNo
customPropertiesAWSJSONAdditional custom properties for the packageNo

Headers

Authorization – $idToken

Request Body​

mutation createPackageTransferOrder {
createPackageTransferOrders(
input: {
id: "TEST_PACKAGE_TRANSFER_ORDER"
transferFromId: "Location A"
transferToId: "Location B"
packages: [
{
id: "PKG-001"
trackerSerial: "EPC1"
reuseTrackerSerial: false
name: "Electronics Box"
description: "Contains tablets"
comments: "Handle with care"
locationId: "Bin-A1"
customProperties: "{\"weight\": \"10lbs\"}"
}
{
id: "PKG-002"
trackerSerial: "EPC2"
reuseTrackerSerial: true
name: "Books Box"
description: "Contains books"
comments: "Top shelf"
locationId: "Bin-B2"
customProperties: "{\"weight\": \"15lbs\"}"
}
]
}
) {
packageTransferOrder {
id
status
transferFrom {
id
}
transferTo {
id
}
packages {
id
trackerSerial
name
description
comments
lastDetectedAtLocation {
id
}
customProperties
}
creationDate
startDate
stagedDate
stagedQuantity
shippedDate
shippedQuantity
cancelledDate
lastUpdatedDate
customProperties
}
}
}

Status Code - 200

Response Body​

PackageTransferOrder {
id: String
status: TransferOrderStatus
transferFrom: LocationV2
transferTo: LocationV2
creationDate: AWSTimestamp
startDate: AWSTimestamp
completedDate: AWSTimestamp
cancelledDate: AWSTimestamp
packages: [Package!]!
lastUpdatedDate: AWSTimestamp
customProperties: AWSJSON
}

Errors​

See authorization errors.

Additional 200-Level Errors​

ErrorError descriptionError code
ValidationErrorNo id provided, no entries, quantity ≤ 0, no item type, duplicate item type200
ResourceNotFoundErrorTracker serial does not exist200
UnexpectedErrorSome unexpected things happened on create, duplicate locations with the same identifier200
LocationNotFoundErrorFrom/to location not found200
ResourceAlreadyExistErrorTransfer order with this identifier already exists200

Update Transfer Order API​

Update Transfer Order API allows you to modify an existing transfer order, including changing its locations, updating the tracker, and adding or removing packages.

Endpoint Details​

  • URL: https://api.xemelgo.com/graphql
  • Method: POST

Properties​

PropertyTypeDescriptionRequired
idStringUnique identifier of the transfer order to updateYes
trackerSerialStringUpdated tracker serial numberNo
transferFromIdStringUpdated source location IDNo
transferToIdStringUpdated destination location IDNo
packagesToAdd[PackageInput!]List of new packages to add (defined below)No
packageIdsToRemove[String!]List of package IDs to remove from the transferNo
customPropertiesAWSJSONAdditional custom properties associated with the transfer orderNo

packagesToAdd​

Each object in the packagesToAdd array includes the following properties:

PropertyTypeDescriptionRequired
idStringUnique package IDYes
trackerSerialStringTracker serial number assigned to the packageNo
reuseTrackerSerialBooleanIndicates if the tracker serial can be reusedNo
nameStringName of the packageNo
descriptionStringDescription of the packageNo
commentsStringAdditional comments about the packageNo
locationIdStringLocation ID where the package is currently storedNo
customPropertiesAWSJSONAdditional custom properties for the packageNo

Headers

Authorization – $idToken

Request Body​

mutation updatePackageTransferOrder {
updatePackageTransferOrder(
input: {
id: "TEST_PACKAGE_TRANSFER_ORDER"
trackerSerial: "EPC3"
transferFromId: "Location A"
transferToId: "Location C"
packagesToAdd: [
{
id: "PKG-003"
trackerSerial: "EPC3"
reuseTrackerSerial: false
name: "Camera Box"
description: "Contains cameras"
comments: "Fragile"
locationId: "Bin-C3"
customProperties: "{\"weight\": \"5lbs\"}"
}
]
packageIdsToRemove: ["PKG-002"]
customProperties: "{\"priority\": \"high\"}"
}
) {
packageTransferOrder {
id
status
transferFrom {
id
}
transferTo {
id
}
packages {
id
trackerSerial
name
description
comments
lastDetectedAtLocation {
id
}
customProperties
}
creationDate
startDate
stagedDate
stagedQuantity
shippedDate
shippedQuantity
cancelledDate
lastUpdatedDate
customProperties
}
}
}

Status Code - 200

Response Body​

PackageTransferOrder {
id: String
status: TransferOrderStatus
transferFrom: LocationV2
transferTo: LocationV2
creationDate: AWSTimestamp
startDate: AWSTimestamp
completedDate: AWSTimestamp
cancelledDate: AWSTimestamp
packages: [Package!]!
lastUpdatedDate: AWSTimestamp
customProperties: AWSJSON
}

Errors​

See authorization errors.


Get Transfer Order API​

Get Transfer Order API allows you to retrieve a specific package transfer order and view its status.

Endpoint Details​

  • URL: https://api.xemelgo.com/graphql
  • Method: POST

Properties​

PropertyTypeDescriptionRequired
idStringPackage transfer order IDYes

Headers

Authorization – $idToken

Request Body​

query packageTransferOrder($id: String) {
packageTransferOrder(input: { id: $id }) {
packageTransferOrder {
id
status
transferFrom {
id
}
transferTo {
id
}
packages {
id
trackerSerial
name
description
comments
lastDetectedAtLocation {
id
}
customProperties
}
creationDate
startDate
stagedDate
stagedQuantity
shippedDate
shippedQuantity
cancelledDate
lastUpdatedDate
customProperties
}
}
}

Status Code - 200

Response Body​

PackageTransferOrder {
id: String
status: TransferOrderStatus
transferFrom: LocationV2
transferTo: LocationV2
creationDate: AWSTimestamp
startDate: AWSTimestamp
completedDate: AWSTimestamp
cancelledDate: AWSTimestamp
packages: [Package!]!
lastUpdatedDate: AWSTimestamp
customProperties: AWSJSON
}

Errors​

See authorization errors.

Additional 200-Level Errors​

ErrorError descriptionError code
ValidationErrorNo id provided200
ResourceNotFoundErrorTransfer order not found200

List Transfer Orders API​

List Transfer Orders API allows you to retrieve all package transfer orders and view their statuses.

Endpoint Details​

  • URL: https://api.xemelgo.com/graphql
  • Method: POST

Properties​

PropertyTypeDescriptionRequired
filterStringFilter for package transfer propertiesNo
nextTokenStringPagination supportNo

Headers

Authorization – $idToken

Request Body​

query packageTransferOrders($filter: String, $nextToken: String) {
packageTransferOrders(input: { filter: $filter, nextToken: $nextToken }) {
packageTransferOrder {
id
status
transferFrom {
id
}
transferTo {
id
}
packages {
id
trackerSerial
name
description
comments
lastDetectedAtLocation {
id
}
customProperties
}
creationDate
startDate
stagedDate
stagedQuantity
shippedDate
shippedQuantity
cancelledDate
lastUpdatedDate
customProperties
}
}
}

Status Code - 200

Response Body​

PackageTransferOrder {
id: String
status: TransferOrderStatus
transferFrom: LocationV2
transferTo: LocationV2
creationDate: AWSTimestamp
startDate: AWSTimestamp
completedDate: AWSTimestamp
cancelledDate: AWSTimestamp
packages: [Package]!
lastUpdatedDate: AWSTimestamp
customProperties: AWSJSON
}

Errors​

See authorization errors.


Delete Transfer Order API​

Delete Transfer Order API allows you to remove a package transfer order.

Endpoint Details​

  • URL: https://api.xemelgo.com/graphql
  • Method: POST

Properties​

PropertyTypeDescriptionRequired
idStringPackage transfer order IDYes

Headers

Authorization – $idToken

Request Body​

mutation deletePackageTransferOrder {
deletePackageTransferOrder(input: { id: "TEST_PACKAGE_TRANSFER_ORDER" }) {
packageTransferOrder {
id
status
transferFrom {
id
}
transferTo {
id
}
packages {
id
trackerSerial
name
description
comments
lastDetectedAtLocation {
id
}
customProperties
}
creationDate
startDate
stagedDate
stagedQuantity
shippedDate
shippedQuantity
cancelledDate
lastUpdatedDate
customProperties
}
}
}

Status Code - 200

Response Body​

PackageTransferOrder {
id: String
status: TransferOrderStatus
transferFrom: LocationV2
transferTo: LocationV2
creationDate: AWSTimestamp
startDate: AWSTimestamp
completedDate: AWSTimestamp
cancelledDate: AWSTimestamp
packages: [Package!]!
lastUpdatedDate: AWSTimestamp
customProperties: AWSJSON
}

Errors​

See authorization errors.

Additional 200-Level Errors​

ErrorError descriptionError code
ValidationErrorNo id provided200
ResourceNotFoundErrorTransfer order not found200